feat: Add opt-in flag and ClientInterceptor to propagate trace context for Spanner end to end tracing #3162
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…o e2e-tracing-header
…o grpc-telemetry-client-interceptor
product-auto-label
bot
added
size: xs
product-auto-label
bot
added
size: m
…o grpc-telemetry-client-interceptor
…o e2e-tracing-header
…o grpc-telemetry-client-interceptor
olavloite
reviewed
Jul 16, 2024
...-cloud-spanner/src/main/java/com/google/cloud/spanner/spi/v1/SpannerInterceptorProvider.java
Outdated
Show resolved
Hide resolved
google-cloud-spanner/src/main/java/com/google/cloud/spanner/spi/v1/TraceContextInterceptor.java
Outdated
Show resolved
Hide resolved
google-cloud-spanner/src/main/java/com/google/cloud/spanner/spi/v1/TraceContextInterceptor.java
Show resolved
Hide resolved
google-cloud-spanner/src/main/java/com/google/cloud/spanner/spi/v1/TraceContextInterceptor.java
Outdated
Show resolved
Hide resolved
google-cloud-spanner/src/main/java/com/google/cloud/spanner/spi/v1/TraceContextInterceptor.java
Outdated
Show resolved
Hide resolved
google-cloud-spanner/src/main/java/com/google/cloud/spanner/spi/v1/TraceContextInterceptor.java
Outdated
Show resolved
Hide resolved
google-cloud-spanner/src/main/java/com/google/cloud/spanner/spi/v1/TraceContextInterceptor.java
Outdated
Show resolved
Hide resolved
google-cloud-spanner/src/test/java/com/google/cloud/spanner/spi/v1/GapicSpannerRpcTest.java
Show resolved
Hide resolved
google-cloud-spanner/src/main/java/com/google/cloud/spanner/spi/v1/TraceContextInterceptor.java
Outdated
Show resolved
Hide resolved
...-cloud-spanner/src/main/java/com/google/cloud/spanner/spi/v1/SpannerInterceptorProvider.java
Outdated
Show resolved
Hide resolved
…o e2e-tracing-header
…o e2e-tracing-header
…o grpc-telemetry-client-interceptor
product-auto-label
bot
added
size: l
nareshz
changed the title
surbhigarg92
reviewed
Aug 9, 2024
google-cloud-spanner/src/main/java/com/google/cloud/spanner/SpannerOptions.java
Outdated
Show resolved
Hide resolved
google-cloud-spanner/src/main/java/com/google/cloud/spanner/SpannerOptions.java
Outdated
Show resolved
Hide resolved
surbhigarg92
approved these changes
Aug 12, 2024
olavloite
approved these changes
Aug 14, 2024
google-cloud-spanner/src/main/java/com/google/cloud/spanner/SpannerOptions.java
Outdated
Show resolved
Hide resolved
google-cloud-spanner/src/main/java/com/google/cloud/spanner/SpannerOptions.java
Outdated
Show resolved
Hide resolved
google-cloud-spanner/src/main/java/com/google/cloud/spanner/SpannerOptions.java
Outdated
Show resolved
Hide resolved
…o grpc-telemetry-client-interceptor
…o grpc-telemetry-client-interceptor
…o grpc-telemetry-client-interceptor
…o grpc-telemetry-client-interceptor
rahul2393
added
the
kokoro:force-run
yoshi-kokoro
removed
the
kokoro:force-run
rahul2393
added
the
do not merge
nareshz
force-pushed
the
grpc-telemetry-client-interceptor
branch
from
ffa6a3f
to
117c279
Compare
nareshz
changed the title
rahul2393
removed
the
do not merge
rahul2393
added
the
kokoro:force-run
yoshi-kokoro
removed
the
kokoro:force-run
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR add changes required for enabling tracing on Spanner side. The changes include:
Add
x-goog-spanner-end-to-end-tracingheader to Spanner RPC contexts.The header is added to support spanner tracing feature, which aims to create trace spans at Spanner layer to provide more context to customers on their requests to Spanner.
This feature is off by default and can be enabled by any of the following ways:
Opting-in while creating Spanner object.
Spanner spanner = SpannerOptions.newBuilder().setEnableEndToEndTracing(true).build().getService();Set the
SPANNER_ENABLE_END_TO_END_TRACINGenvironment variable totrue.For Spanner tracing feature,
traceparentheader is required on the Spanner layer in all the requests. This change helps in passingtraceparentheader inside Spanner requests if Context propagators are setup in OpenTelemetrySdk.traceparentheader will be only added if client has opted-in for spanner tracing by setting thesetEnableEndToEndTracingoption in SpannerOptions.